extensionUtils: Add openPrefs() convenience method

Opening their own preferences is a reasonable desire for extensions,
so make up for breaking it by adding a convenience method for that
action.

https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/1163

diff --git a/js/misc/extensionUtils.js b/js/misc/extensionUtils.js
index af2338f450588370a39d1392e2c8687910be1ef7..e9697d4684605fad01eea47388c46b70a3dd8a5d 100644 (file)
--- a/js/misc/extensionUtils.js
+++ b/js/misc/extensionUtils.js
@@ -1,7 +1,7 @@
 // -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
 /* exported ExtensionState, ExtensionType, getCurrentExtension,
-   getSettings, initTranslations, isOutOfDate, installImporter,
-   serializeExtension, deserializeExtension */
+   getSettings, initTranslations, openPrefs, isOutOfDate,
+   installImporter, serializeExtension, deserializeExtension */
 
 // Common utils for the extension system and the extension
 // preferences tool
@@ -153,6 +153,27 @@ function getSettings(schema) {
     return new Gio.Settings({ settings_schema: schemaObj });
 }
 
+/**
+ * openPrefs:
+ *
+ * Open the preference dialog of the current extension
+ */
+function openPrefs() {
+    const extension = getCurrentExtension();
+
+    if (!extension)
+        throw new Error('openPrefs() can only be called from extensions');
+
+    try {
+        const extensionManager = imports.ui.main.extensionManager;
+        extensionManager.openExtensionPrefs(extension.uuid, '', {});
+    } catch (e) {
+        if (e.name === 'ImportError')
+            throw new Error('openPrefs() cannot be called from preferences');
+        logError(e, 'Failed to open extension preferences');
+    }
+}
+
 /**
  * versionCheck:
  * @param {string[]} required - an array of versions we're compatible with